package panda.lang.codec;

/**
 * Thrown when there is a failure condition during the encoding process. This exception is thrown when an
 * {@link Encoder} encounters a encoding specific exception such as invalid data, inability to calculate a checksum,
 * characters outside of the expected range.
 */
public class EncoderException extends RuntimeException {
	/**
	 * Declares the Serial Version Uid.
	 * 
	 * @see <a href="http://c2.com/cgi/wiki?AlwaysDeclareSerialVersionUid">Always Declare Serial
	 *      Version Uid</a>
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * Constructs a new exception with {@code null} as its detail message. The cause is not
	 * initialized, and may subsequently be initialized by a call to {@link #initCause}.
	 */
	public EncoderException() {
		super();
	}

	/**
	 * Constructs a new exception with the specified detail message. The cause is not initialized,
	 * and may subsequently be initialized by a call to {@link #initCause}.
	 * 
	 * @param message a useful message relating to the encoder specific error.
	 */
	public EncoderException(final String message) {
		super(message);
	}

	/**
	 * Constructs a new exception with the specified detail message and cause.
	 * <p>
	 * Note that the detail message associated with <code>cause</code> is not automatically
	 * incorporated into this exception's detail message.
	 * </p>
	 * 
	 * @param message The detail message which is saved for later retrieval by the
	 *            {@link #getMessage()} method.
	 * @param cause The cause which is saved for later retrieval by the {@link #getCause()} method.
	 *            A {@code null} value is permitted, and indicates that the cause is nonexistent or
	 *            unknown.
	 */
	public EncoderException(final String message, final Throwable cause) {
		super(message, cause);
	}

	/**
	 * Constructs a new exception with the specified cause and a detail message of
	 * <code>(cause==null ?
	 * null : cause.toString())</code> (which typically contains the class and detail message of
	 * <code>cause</code>). This constructor is useful for exceptions that are little more than
	 * wrappers for other throwables.
	 * 
	 * @param cause The cause which is saved for later retrieval by the {@link #getCause()} method.
	 *            A {@code null} value is permitted, and indicates that the cause is nonexistent or
	 *            unknown.
	 */
	public EncoderException(final Throwable cause) {
		super(cause);
	}
}
